home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine CD 1995 / Archive Magazine CD 1995.iso / discs / prog_disc / volume_8 / issue_07 / std / !STDFinder / Readme < prev    next >
Encoding:
Text File  |  1993-07-06  |  9.7 KB  |  253 lines
  1. ############################################################
  2. #                    !STDFinder V1.01                      #
  3. #     By Julyan Bristow August 1993 - June 1993            #
  4. ############################################################
  5.  
  6. ReadMe file for !STDFinder
  7.  
  8. 1.0 Introduction
  9. ################
  10.  
  11. The purpose of this program is to allow users to match towns
  12. with their STD dialling codes, and vice versa.  Wildcard
  13. matching is allowed, and export of the entire database, or a
  14. subset is allowed.  Editing of the data through addition or 
  15. deletion of database entries is allowed.
  16.  
  17. 2.0 The Program
  18. ###############
  19.  
  20. The program installs on the icon bar in the normal way.
  21. Three options are currently available from the icon bar
  22. menu:
  23.  
  24.         Info            Self explanatory
  25.         Search            "    "     "
  26.         Quit              "    "     "
  27.  
  28. 2.1 'Info'
  29. ##########
  30. Clicking or following the arrow gives the usual information
  31. on version number and author of the program.
  32.  
  33. 2.2 'Search'
  34. ############
  35. Clicking on the icon itself, or selecting this option from
  36. the menu allows searching of the STD Code 'database'.  This
  37. pops up a dialogue box with 3 menu items, 1 entry field, 2 
  38. output fields, 2 arrow icons and a selectable exact option. 
  39.  
  40. The town or code to be found should be entered in the box
  41. under the menu icons as indicated.
  42.  
  43. To commence the search, either click with the left mouse
  44. button over the 'Search' icon, or press return.  If none 
  45. are found, a beep will sound.  If the search criteria is met,
  46. then those towns and codes meeting the search criteria will 
  47. appear in a window below, which can be scrolled to view all
  48. entries, should there be more than the number appearing in the
  49. window.
  50.  
  51. Selection of the 'exact' option means that the database will be
  52. searched only for an exact match of the user's search string.
  53. Eg if the search string is 'Bedworth', then only matches exactly
  54. equal to this will be identified.  This the same for the dialling
  55. codes
  56.  
  57. If the exact option is not selected, then a match will be found 
  58. if the users search string is contained within any of the entries 
  59. of the database.  This is case independent.  Eg if the search 
  60. string is 'worth', then 'Bedworth', 'Bagworthy' and 'Worthing'
  61. will all be valid.
  62.  
  63. Use of Wildcards (v0.09 onwards):
  64. A simple wildcards search is now permitted.  The wildcard symbol 
  65. is '*'.  Wildcards are currently used (v0.09) to determine whether
  66. the search is to be from the start or the end each of the database
  67. strings.
  68.  
  69. To clarify this consider, the search string 'worth' once again.
  70. If 'worth' is entered then the results will be similar to those 
  71. described above.  However, if 'worth*' is entered then only towns
  72. beginning with the string worth will be found Eg Worthing.  If 
  73. '*worth' is entered then only towns with the last 5 characters of 
  74. worth will be found Eg Bedworth.  Finally if *worth* is entered 
  75. then only towns containing the 5 characters 'worth' in their name, 
  76. but not at the start or end will be found Eg Bagworthy.
  77.  
  78. If wildcards are not positioned in the first or last position 
  79. of the search string, or there are more than 2 wildcards
  80. entered, then an error will be reported (most of the time!) and 
  81. at the very least no string will be found.
  82.  
  83. Wildcards are not permitted with the exact option set to on.
  84.  
  85. Clicking 'menu' over this window gives two further options - Edit 
  86. and Save, each with a further submenu.
  87.  
  88. The Edit option submenu allows addition of new data and deletion of
  89. existing data.  Selection of either of these will pop up a second
  90. dialogue box containing 3 fields for entry of the town, its code 
  91. and a menu icon to carry out either the deletion or addition.  
  92. Currently, this dialogue box will not move, neither will the cursor
  93. keys move the text caret, so you will have to use the mouse.  I am 
  94. currently looking into this.
  95.  
  96. Addition of a new entry will always enter the text string into the 
  97. format 'Xxxxx Xxxxxx Xx Xxxx' depending on the number of words to be
  98. entered. Eg wOrhTinG is entered as Worthing.  The new entry is 
  99. added in sorted order, so if the data is to be used elsewhere there
  100. is no need to sort it before use.
  101.  
  102. On deletion, only an exact match of both the town and the code will
  103. allow deletion of the entry.
  104.  
  105. The Save option submenu gives two choices.  The first is to save the
  106. entire database to a text file.  The second is to save all the entries
  107. found after a search to a text file.  This option is disabled if there
  108. are no entries found.
  109.  
  110. 2.4 'Quit'
  111. ##########
  112. Select this to quit the program.  A check is made to ensure that any
  113. additions or deletions to the database will be saved at the users 
  114. discretion.
  115.  
  116. 2.5 'Load User Directories'
  117. ###########################
  118. Option added at version 1.00. The user may add their own data to the
  119. program.  This is done by dragging a text file to the icon on the icon
  120. bar.  This will pop a dialogue box to give the user the oppotunity to 
  121. append the data, or overwrite the current data, or to cancel if required.
  122. The data is sorted as it is added to the database, and so can take some
  123. time if large datafiles are added.
  124.  
  125. The file format is as follows: A text file, with the town name followed
  126. a comma, followed by the code. The last line of the file should be data, 
  127. and there should be no blank line. 
  128.  
  129. 3.0 Program Limitations
  130. #######################
  131. Wildcard option a bit simple.
  132. Does not release memory at the start of each new search.
  133.  
  134. 4.0 Proposed Program Enhancements
  135. ##################################
  136. Proposed enhancements are as follows:
  137. (i)     Compression of the database for smaller overall program disk
  138.         space.
  139. (ii)    Use flex.h or heap.h to use memory releasing routines.
  140.  
  141. 5.0 Version History
  142. ###################
  143. Version 0.01: August 1992
  144. Initial version of the program working in a desktop
  145. enviroment.  'Info', 'Search' and 'Quit' routines
  146. implemented with a limited database.
  147.  
  148. Version 0.04: September 1992
  149. Tidying up of code of version 0.01.  All STD codes entered
  150. into database.
  151.  
  152. Version 0.05: 25 September 1992
  153. Further coding improvements.  Facility added to make search
  154. criteria case independant. Eg LonDoN will now be found.
  155.  
  156. Version 0.06: 2 October 1992
  157. Further coding improvements. Bubble sort routine added to
  158. sort database either by code or by town.  Export routine
  159. included to allow easy export of the sorted data to !EDIT,
  160. printers etc.
  161.  
  162. Version 0.07: 2 October 1992
  163. Replaced bubble sort with the quick sort algorithm.
  164.  
  165. Version 0.08: 23 December 1992
  166. Added faded arrow fields. Added exact search option, and changed
  167. existing search option to allow the search string to be found if it
  168. is contained in any of the database entries.  Removed radio icons 
  169. for selection of search by town or code - difference automatically
  170. detected.
  171.  
  172. Version 0.09: 31 December 1992
  173. Added a relatively simple wild card search option. Attempted to
  174. make the exact search detection a bit more robust.
  175.  
  176. Version 0.10: 9 January 1993
  177. Improved robustness of exact icon operation and allowed the 
  178. RETURN key to start the search after entry of the code or town.
  179. Thanks to Craig Murphy and Shanawaz Basith for the tips for the above.
  180.  
  181. Version 0.16: 23 February 1993
  182. Temporary removal of sort option.  Change program to use doubly linked
  183. dynamic lists (no restriction other than memory on database or search
  184. sizes). Addition of menu structure to the search window.  Addition of 
  185. add and delete database entries.  Addition of save complete database and
  186. save searched subset.
  187.  
  188. Version 1.00: 8 March 1993
  189. Added features: drag user directory to database - append or overwrite.
  190. Check before quitting if need to save any new data.
  191. Fully released into public domain.
  192.  
  193. Version 1.01: 22 March 1993
  194. Error in saving modified database data corrected. When saving data 
  195. from the search menu, width of town now determined by maximum length 
  196. of data read in, so town name is never truncated.
  197.  
  198. Version 2.00: 16 June 1993
  199. All towns meeting the search criteria now displayed in a window.
  200.  
  201. 6.0 Notes
  202. #########
  203.  
  204. The dialling codes are due to change sometime in 1993 (I think!).
  205. A second database file is included called Newcodes with the new codes
  206. in.  Please do not take this as gospel though please!
  207.  
  208. This program is Public Domain.  Please feel free to
  209. distribute it as you wish. Please make sure that all the
  210. files listed below are included:
  211.  
  212.         !Boot
  213.         !Run
  214.         !Runimage       The executable code
  215.         !Sprites        The application sprites
  216.         Sprites         The resource sprites 
  217.         Templates       The application template file
  218.         Newcodes        The database of all STD codes
  219.         c               Directory containing the source code.
  220.         Directorys      Directory containing various different
  221.                         STD Code directories.
  222.  
  223. Please do not take credit where it is not due!  It took me
  224. hours to type in all the codes (all 5000+ of them) so at 
  225. least give me some credit. I was going to encode the
  226. data, but it is not really worth all that much bother, so
  227. please do not abuse my trust.
  228.  
  229. The STD codes in the program are taken from the September
  230. 1991 Birmingham Telephone Directory.  I cannot (and will
  231. not) be held responsible for any errors that may have
  232. slipped in.  Also included is a subdirectory containing
  233. the local codes for the Birmingham exchange.  Please send
  234. me similar data for other cities eg Manchester, London etc
  235. so that the database can improve in usefulness!
  236.  
  237. However, I will be very grateful if any mistakes are
  238. highlighted and sent to me at the address below, so that
  239. any future versions will contain fewer errors.  If any
  240. one else out there is keen on C desktop (or otherwise)
  241. programming I will be pleased to hear from you for swapping
  242. of hints and tips etc.  Also if anyone can think of better
  243. sprite then please send it in - I am useless at drawing.
  244. Credit will be given as apropriate.
  245.  
  246. Please write to 
  247.  
  248.         Julyan Bristow
  249.         40 Dunard Road
  250.         SHIRLEY
  251.         SOLIHULL
  252.         WEST MIDLANDS
  253.         B90 2HR